home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / mklfs / mklfs.man < prev   
Encoding:
Text File  |  1992-09-08  |  4.4 KB  |  100 lines
  1. '\" Copyright 1989 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/src/admin/mklfs/RCS/mklfs.man,v 1.3 91/12/17 22:14:25 jhh Exp $ SPRITE (Berkeley)
  10. '/" 
  11. .so \*(]ltmac.sprite
  12. .HS MKLFS cmds
  13. .BS
  14. .SH NAME
  15. mklfs \- Create an empty LFS file system on a disk partition.
  16. .SH SYNOPSIS
  17. .nf
  18. \fBmklfs [\fIoptions\fR] \fIdeviceName\fR [\fIprefix\fR]
  19. .SH OPTIONS
  20. .IP \fIdeviceName\fP 14
  21. The device on which the file system should be created. This device
  22. should be a disk partition complete with a disk label that specifies
  23. its size.  WARNING: THE CONTENTS OF THIS DEVICE ARE OVERWRITTEN BY MKLFS.
  24. .IP \fIprefix\fP 14
  25. Name of the file system (its prefix).
  26. You only need to specify this prefix if you wish to have the
  27. file system automatically mounted by \fBfsmount\fP 
  28. during the boot sequence.
  29. You can manually mount the file system under any name you want via the
  30. \fBprefix\fP command.
  31. .IP "\fB\-maxNumCacheBlocks\fI NumCacheBlocks\fR" 14
  32. \fINumCacheBlocks\fP is the maximum number of file cache blocks 
  33. available on the machine. This number defaults to the maximum number
  34. on the machine running the program.  
  35. .IP "\fB\-maxCacheBlocksCleaned\fI NumCacheBlocks\fR" 14
  36. \fINumCacheBlocks\fP is the maximum number of file cache files
  37. that will be reserved for cleaning. A negative value causes mklfs to 
  38. compute this number based on the segment and file cache size.
  39. .IP "\fB\-spriteID\fI id\fR" 14
  40. \fIid\fP is the Sprite hostname id specified in the superblock.  This
  41. id is used to inform a machine of its name at boot time.  It defaults
  42. to the Sprite ID of the machine running mklfs.
  43. .IP "\fB\-maxUtilization\fI Utilization\fR" 14
  44. \fIUtilization\fP is the maximum fraction of the disk space usable by
  45. the file system.  
  46. .IP "\fB\-maxDesc\fI NumDesc\fR" 14
  47. \fINumDesc\fP is the maximum number of descriptors available in the
  48. file system. A negative value causes mklfs to compute this number
  49. based on the disk size.
  50. .IP "\fB\-segAlignment\fI Alignment\fR" 14
  51. \fIAlignment\fP is the alignment in bytes where the first segment should start.
  52. .IP "\fB\-blockSize\fI size\fR" 14
  53. \fIsize\fP is block size of the file system in bytes. The block
  54. size is the minimum unit of allocation and should be a multiple of
  55. the device's sector size.
  56. .IP "\fB\-segmentSize\fI size\fR" 14
  57. \fIsize\fP is the segment size of the file system in bytes. The segment
  58. size should be a multiple of the block size.
  59. .IP "\fB\-numSegments\fI NumSegments\fR" 14
  60. \fINumSegments\fP is the number of segments to use on the file system. A
  61. negative value causes mklfs to compute the number of segments based on
  62. the size of the disk.
  63. .IP "\fB\-descBlockSize\fI size\fR" 14
  64. \fIsize\fP is the size in bytes of the blocks used to store
  65. file descriptors in the log. This number should be a multiple of the
  66. block size.
  67. .IP "\fB\-descMapBlockSize\fI size\fR" 14
  68. \fIsize\fP is the block size in byte used for the descriptor
  69. map data structure. This number should be a multiple of the
  70. block size.
  71. .IP "\fB\-usageArrayBlockSize\fI size\fR" 14
  72. \fIsize\fP is the block size in byte used for the segment
  73. usage array data structure. This number should be a multiple of the
  74. block size.
  75. .IP "\fB\-verbose\fR" 14
  76. Print the values used for the parameters.
  77. .BE
  78.  
  79. .SH DESCRIPTION
  80. .PP
  81. \fBMklfs\fR will create an empty Sprite LFS filesystem on a disk partition. 
  82. The filesystem is created to use the
  83. entire disk partition and initialized to look like an Sprite LFS
  84. file system containing a root directory with a lost+found directory.
  85. Care should be taken because anything already present on the partition
  86. will be overwritten.
  87. .PP
  88. \fBMklfs\fR has a large number of options that control the maximum limits of
  89. various file system data structures, the characteristic of the machine
  90. that will the device for the file system, and the disk layout format
  91. the file system.
  92. All options except the deviceName specifier are optional and default
  93. to reasonable values if not specified.
  94. If the program is being run on a machine other than the one that 
  95. the machine to which the disk will be attached from, the options 
  96. that describe the machine characteristic will need to be specified.
  97. .SH KEYWORDS
  98. filesystem, LFS, sprite
  99.  
  100.